org.springframework.http.codec

Class FormHttpMessageWriter

java.lang.Object

org.springframework.http.codec.FormHttpMessageWriter

All Implemented Interfaces:

HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>>

public class FormHttpMessageWriter
extends java.lang.Object
implements HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>>

Implementation of an HttpMessageWriter to write HTML form data, i.e. response body with media type "application/x-www-form-urlencoded".

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	DEFAULT_CHARSET
private java.nio.charset.Charset	defaultCharset
private static ResolvableType	MULTIVALUE_TYPE

Constructor Summary

Constructors

Constructor and Description
FormHttpMessageWriter()

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this writer.
private java.lang.String	generateForm(MultiValueMap<java.lang.String,java.lang.String> form, java.nio.charset.Charset charset)
java.nio.charset.Charset	getDefaultCharset() Return the configured default charset.
private java.nio.charset.Charset	getMediaTypeCharset(MediaType mediaType)
java.util.List<MediaType>	getWritableMediaTypes() Return the MediaType's that this writer supports.
void	setDefaultCharset(java.nio.charset.Charset charset) Set the default character set to use for writing form data when the response Content-Type header does not explicitly specify it.
<any>	write(<any> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Write an given stream of object to the output message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.http.codec.HttpMessageWriter

write

Field Detail

DEFAULT_CHARSET

public static final java.nio.charset.Charset DEFAULT_CHARSET

MULTIVALUE_TYPE

private static final ResolvableType MULTIVALUE_TYPE

defaultCharset

private java.nio.charset.Charset defaultCharset

Constructor Detail

FormHttpMessageWriter

public FormHttpMessageWriter()

Method Detail

setDefaultCharset

public void setDefaultCharset(java.nio.charset.Charset charset)

Set the default character set to use for writing form data when the response Content-Type header does not explicitly specify it.

By default this is set to "UTF-8".

getDefaultCharset

public java.nio.charset.Charset getDefaultCharset()

Return the configured default charset.

canWrite

public boolean canWrite(ResolvableType elementType,
                        @Nullable
                        MediaType mediaType)

Description copied from interface: HttpMessageWriter

Whether the given object type is supported by this writer.

Specified by:

canWrite in interface HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>>

Parameters:

elementType - the type of object to check

mediaType - the media type for the write, possibly null

Returns:

true if writable, false otherwise

write

public <any> write(<any> inputStream,
                   ResolvableType elementType,
                   @Nullable
                   MediaType mediaType,
                   ReactiveHttpOutputMessage message,
                   java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageWriter

Write an given stream of object to the output message.

Specified by:

write in interface HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>>

Parameters:

inputStream - the objects to write

elementType - the type of objects in the stream which must have been previously checked via HttpMessageWriter.canWrite(ResolvableType, MediaType)

mediaType - the content type for the write, possibly null to indicate that the default content type of the writer must be used.

message - the message to write to

hints - additional information about how to encode and write

Returns:

indicates completion or error

getMediaTypeCharset

private java.nio.charset.Charset getMediaTypeCharset(@Nullable
                                                     MediaType mediaType)

generateForm

private java.lang.String generateForm(MultiValueMap<java.lang.String,java.lang.String> form,
                                      java.nio.charset.Charset charset)

getWritableMediaTypes

public java.util.List<MediaType> getWritableMediaTypes()

Description copied from interface: HttpMessageWriter

Return the MediaType's that this writer supports.

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<MultiValueMap<java.lang.String,java.lang.String>>